/**
 * @file     PredicateRule.h
 * @brief    PredicateRule interface.
 *
 * @author   Franco Riberi
 * @email    fgriberi AT gmail.com
 *
 * Contents: Header file for titere providing PredicateRule interface.
 *
 * System:   titere: Target Ideal TEmperature Rna Expression
 * Language: C++
 *
 * @date January 8, 2014
 *
 * Copyright (C) 2014 Franco Riberi, FuDePAN
 *
 * This file is part of the titere.
 *
 * Titere is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Titere is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with titere. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef PREDICATE_RULE_H
#define PREDICATE_RULE_H

#include <biopp/biopp.h>
#include "titere/Types.h"

namespace NSTitere
{

/**
 * @brief Responsible to represent a rule
 */
struct IPredicateRule
{
    /**
     * @brief Checks whether the rule is met.
     *
     * @param sequence Input sequence
     * @return True if the rule is met, otherwise false.
     */
    virtual bool checkRule(const biopp::NucSequence& sequence) = 0;

    /**
     * @brief Destructor of class
     */
    virtual ~IPredicateRule() {}

    /** @brief Represents the nitrogen bases */
    static const Nucleotide ADENINE  = 'A';
    static const Nucleotide URACIL   = 'U';
    static const Nucleotide CYTOSINE = 'C';
    static const Nucleotide GUANINE  = 'G';
};

} //NSTitere

#endif /* PREDICATE_RULE_H */
